Improve PointerHint docs. Explain is_hint field in GdkEventMotion.

2003-08-28  Matthias Clasen  <maclas@gmx.de>

	* gdk/tmpl/events.sgml: Improve PointerHint docs.
	* gdk/tmpl/event_structs.sgml: Explain is_hint field in GdkEventMotion.
	(#120542)
	* gdk/x11/gdkkeys-x11.c (gdk_keymap_translate_keyboard_state): Markup
	fix in the docs.

diff --git a/ChangeLog b/ChangeLog
index c2d98136d77a07249faa7332397ad4ca0594b3e8..2b2e8c4c854e26423bd59343a51b1b76d1e266e9 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
 2003-08-28  Matthias Clasen  <maclas@gmx.de>
 
+       * gdk/x11/gdkkeys-x11.c (gdk_keymap_translate_keyboard_state): Markup
+       fix in the docs.
+
        * gtk/gtkuimanager.c: Change the XML format:
        <Root> element is replaced by <ui>,
        <menu> element is replaced by <menubar>,

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index c2d98136d77a07249faa7332397ad4ca0594b3e8..2b2e8c4c854e26423bd59343a51b1b76d1e266e9 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,5 +1,8 @@
 2003-08-28  Matthias Clasen  <maclas@gmx.de>
 
+       * gdk/x11/gdkkeys-x11.c (gdk_keymap_translate_keyboard_state): Markup
+       fix in the docs.
+
        * gtk/gtkuimanager.c: Change the XML format:
        <Root> element is replaced by <ui>,
        <menu> element is replaced by <menubar>,

diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4
index c2d98136d77a07249faa7332397ad4ca0594b3e8..2b2e8c4c854e26423bd59343a51b1b76d1e266e9 100644 (file)
--- a/ChangeLog.pre-2-4
+++ b/ChangeLog.pre-2-4
@@ -1,5 +1,8 @@
 2003-08-28  Matthias Clasen  <maclas@gmx.de>
 
+       * gdk/x11/gdkkeys-x11.c (gdk_keymap_translate_keyboard_state): Markup
+       fix in the docs.
+
        * gtk/gtkuimanager.c: Change the XML format:
        <Root> element is replaced by <ui>,
        <menu> element is replaced by <menubar>,

diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
index c2d98136d77a07249faa7332397ad4ca0594b3e8..2b2e8c4c854e26423bd59343a51b1b76d1e266e9 100644 (file)
--- a/ChangeLog.pre-2-6
+++ b/ChangeLog.pre-2-6
@@ -1,5 +1,8 @@
 2003-08-28  Matthias Clasen  <maclas@gmx.de>
 
+       * gdk/x11/gdkkeys-x11.c (gdk_keymap_translate_keyboard_state): Markup
+       fix in the docs.
+
        * gtk/gtkuimanager.c: Change the XML format:
        <Root> element is replaced by <ui>,
        <menu> element is replaced by <menubar>,

diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index c2d98136d77a07249faa7332397ad4ca0594b3e8..2b2e8c4c854e26423bd59343a51b1b76d1e266e9 100644 (file)
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,5 +1,8 @@
 2003-08-28  Matthias Clasen  <maclas@gmx.de>
 
+       * gdk/x11/gdkkeys-x11.c (gdk_keymap_translate_keyboard_state): Markup
+       fix in the docs.
+
        * gtk/gtkuimanager.c: Change the XML format:
        <Root> element is replaced by <ui>,
        <menu> element is replaced by <menubar>,

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 8193a01dc75af120c2b461e7a42e180bd5f11a62..283fab7eb9563665ded1815cabf4b0e7a21c0600 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,9 @@
+2003-08-28  Matthias Clasen  <maclas@gmx.de>
+
+       * gdk/tmpl/events.sgml: Improve PointerHint docs.
+       * gdk/tmpl/event_structs.sgml: Explain is_hint field in GdkEventMotion.
+       (#120542)
+
 2003-08-26  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/gtk-sections.txt: Rename GtkMenuMerge to GtkUIManager

diff --git a/docs/reference/gdk/tmpl/event_structs.sgml b/docs/reference/gdk/tmpl/event_structs.sgml
index 9767a81f0903e496c6270187aa669ffa11d351ec..ee9341219d4cc3af3df304562749da1fed2d097e 100644 (file)
--- a/docs/reference/gdk/tmpl/event_structs.sgml
+++ b/docs/reference/gdk/tmpl/event_structs.sgml
@@ -203,7 +203,8 @@ Generated when the pointer moves.
   the mouse.
 @state: a bit-mask representing the state of the modifier keys (e.g. Control,
   Shift and Alt) and the pointer buttons. See #GdkModifierType.
-@is_hint: 
+@is_hint: set to 1 if this event is just a hint, see the %GDK_POINTER_MOTION_HINT_MASK
+  value of #GdkEventMask.
 @device: the device where the event originated.
 @x_root: the x coordinate of the pointer relative to the root of the screen.
 @y_root: the y coordinate of the pointer relative to the root of the screen.
@@ -471,7 +472,7 @@ Specifies the state of a toplevel window.
 @GDK_WINDOW_STATE_ICONIFIED: the window is minimized.
 @GDK_WINDOW_STATE_MAXIMIZED: the window is maximized.
 @GDK_WINDOW_STATE_STICKY: the window is sticky.
-@GDK_WINDOW_STATE_FULLSCREEN: the window is maximized without decorations. 
+@GDK_WINDOW_STATE_FULLSCREEN: the window is maximized without decorations.
 @GDK_WINDOW_STATE_ABOVE: the window is kept above other windows.
 @GDK_WINDOW_STATE_BELOW: the window is kept below other windows.
 

diff --git a/docs/reference/gdk/tmpl/events.sgml b/docs/reference/gdk/tmpl/events.sgml
index acdc33044a9c85317a4bdf1342d1bdeafbb8415b..caabb4411dff23b1d181e564e1d247169dafcd02 100644 (file)
--- a/docs/reference/gdk/tmpl/events.sgml
+++ b/docs/reference/gdk/tmpl/events.sgml
@@ -97,8 +97,9 @@ number of %GDK_MOTION_NOTIFY events received. Normally a %GDK_MOTION_NOTIFY
 event is received each time the mouse moves. However, if the application
 spends a lot of time processing the event (updating the display, for example),
 it can easily lag behind the position of the mouse. When using the
-%GDK_POINTER_MOTION_HINT_MASK the server will only send %GDK_MOTION_NOTIFY
-events when the application asks for them, by calling gdk_window_get_pointer().
+%GDK_POINTER_MOTION_HINT_MASK the server will only send a single %GDK_MOTION_NOTIFY
+event (which is marked as a hint) until the application asks for more, by calling 
+gdk_window_get_pointer().
 </para>
 
 @GDK_EXPOSURE_MASK: 

diff --git a/gdk/x11/gdkkeys-x11.c b/gdk/x11/gdkkeys-x11.c
index 5b26b34a12c24e8b6782b41feb1d1eaa5fde9348..d58f862dde0c059b25b88e3716a17d0d61bd9c85 100644 (file)
--- a/gdk/x11/gdkkeys-x11.c
+++ b/gdk/x11/gdkkeys-x11.c
@@ -1114,12 +1114,12 @@ translate_keysym (GdkKeymapX11   *keymap_x11,
  * </para>
  * <informalexample><programlisting>
  * &sol;* We want to ignore irrelevant modifiers like ScrollLock *&sol;
- * #define ALL_ACCELS_MASK (GDK_CONTROL_MASK | GDK_SHIFT_MASK | GDK_MOD1_MASK)
+ * &num;define ALL_ACCELS_MASK (GDK_CONTROL_MASK | GDK_SHIFT_MASK | GDK_MOD1_MASK)
  * gdk_keymap_translate_keyboard_state (keymap, event->hardware_keycode,
  *                                      event->state, event->group,
- *                                      &keyval, NULL, NULL, &consumed);
+ *                                      &amp;keyval, NULL, NULL, &amp;consumed);
  * if (keyval == GDK_PLUS &&
- *     (event->state & ~consumed & ALL_ACCELS_MASK) == GDK_CONTROL_MASK)
+ *     (event->state &amp; ~consumed &amp; ALL_ACCELS_MASK) == GDK_CONTROL_MASK)
  *   &sol;* Control was pressed *&sol;
  * </programlisting></informalexample>
  * <para>
@@ -1130,7 +1130,7 @@ translate_keysym (GdkKeymapX11   *keymap_x11,
  * <informalexample><programlisting>
  * &sol;* XXX Don't do this XXX *&sol;
  * if (keyval == accel_keyval &&
- *     (event->state & ~consumed & ALL_ACCELS_MASK) == (accel_mods & ~consumed))
+ *     (event->state &amp; ~consumed &amp; ALL_ACCELS_MASK) == (accel_mods &amp; ~consumed))
  *   &sol;* Accelerator was pressed *&sol;
  * </programlisting></informalexample>
  * <para>